// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// Author: wsfuyibing <682805@qq.com>
// Date: 2024-08-02

package types

import "time"

// Date
// is a type name for date format in a table.
//
//	type Example struct{
//	    Id int64 `json:"id" xorm:"id pk autoincr"`
//	    Date db.Date `json:"date" xorm:"date"`
//	}
//
//	t := db.Date("2024-04-11")
type Date string

// NewDate
// creates an object based on current system time.
func NewDate() Date {
	return Date(time.Now().Format(time.DateOnly))
}

// String
// convert to a string.
func (o Date) String() string {
	return string(o)
}

// Time
// convert to time.Time.
func (o Date) Time() time.Time {
	if t, err := time.ParseInLocation(time.DateOnly, o.String(), loc); err == nil {
		return t
	}
	return earliestDatetime
}
